<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Agent</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> Agent</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Agent Class - Fedora API-A and API-M Interface class</p>
	<ul class="tags">
				<li><span class="field">author:</span> prashant pandey &lt;<a href="mailto:prashant.pandey@unisa.edu.au">prashant.pandey@unisa.edu.au</a>&gt;</li>
				<li><span class="field">version:</span> ver1.0</li>
				<li><span class="field">access:</span> public</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_library---logic.php.html">/library/logic.php</a> (line <span class="field">43</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$nextFlag" title="details" class="var-name">$nextFlag</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$pwd" title="details" class="var-name">$pwd</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$searchToken" title="details" class="var-name">$searchToken</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$UrlA" title="details" class="var-name">$UrlA</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$UrlM" title="details" class="var-name">$UrlM</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$user" title="details" class="var-name">$user</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																																																																																																<div class="method-definition">
					<img src="../media/images/Constructor.png" alt=" "/>
											<span class="method-result">Agent</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">timestamp</span>
										<a href="#addDatastream" title="details" class="method-name">addDatastream</a>
											(<span class="var-type">$path</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">$pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">$label</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">$type</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">$group</span>&nbsp;<span class="var-name">$group</span>, <span class="var-type">$state</span>&nbsp;<span class="var-name">$state</span>, <span class="var-type">$log</span>&nbsp;<span class="var-name">$log</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#addDataStreams" title="details" class="method-name">addDataStreams</a>
											(<span class="var-type">$files</span>&nbsp;<span class="var-name">$files</span>, <span class="var-type">$state</span>&nbsp;<span class="var-name">$state</span>, <span class="var-type">$log</span>&nbsp;<span class="var-name">$log</span>, <span class="var-type">$label</span>&nbsp;<span class="var-name">$label</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">xml</span>
										<a href="#arrayToXML" title="details" class="method-name">arrayToXML</a>
											(<span class="var-type">$result</span>&nbsp;<span class="var-name">$result</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#callModifyDatastreamByValue" title="details" class="method-name">callModifyDatastreamByValue</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dsID</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$state</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dsContent</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'text/xml'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$versionable</span> = <span class="var-default">&quot;false&quot;</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">repository</span>
										<a href="#describeRepository" title="details" class="method-name">describeRepository</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">user</span>
										<a href="#describeUser" title="details" class="method-name">describeUser</a>
											(<span class="var-type">id</span>&nbsp;<span class="var-name">$id</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#domNodeList_to_string" title="details" class="method-name">domNodeList_to_string</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$DomNodeList</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">datastream</span>
										<a href="#getDatastream" title="details" class="method-name">getDatastream</a>
											(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">ds</span>&nbsp;<span class="var-name">$ds</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">history</span>
										<a href="#getDatastreamHistory" title="details" class="method-name">getDatastreamHistory</a>
											(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">ds</span>&nbsp;<span class="var-name">$ds</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">datastreams</span>
										<a href="#getDatastreams" title="details" class="method-name">getDatastreams</a>
											(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">DOMELEMENT</span>
										<a href="#getMarcXML" title="details" class="method-name">getMarcXML</a>
											(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">ds</span>&nbsp;<span class="var-name">$ds</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">next</span>
										<a href="#getNextPid" title="details" class="method-name">getNextPid</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$namespace</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">object profile</span>
										<a href="#getObjectProfile" title="details" class="method-name">getObjectProfile</a>
											(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">search</span>
										<a href="#getSearchToken" title="details" class="method-name">getSearchToken</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">the</span>
										<a href="#get_file" title="details" class="method-name">get_file</a>
											(<span class="var-type">$filename</span>&nbsp;<span class="var-name">$filename</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">DOM</span>
										<a href="#InsertXML" title="details" class="method-name">InsertXML</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$source</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ingestSource</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#listDatastreams" title="details" class="method-name">listDatastreams</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">object methods</span>
										<a href="#listMethods" title="details" class="method-name">listMethods</a>
											(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">search</span>
										<a href="#nextSearch" title="details" class="method-name">nextSearch</a>
											(<span class="var-type">$token</span>&nbsp;<span class="var-name">$token</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">search</span>
										<a href="#search" title="details" class="method-name">search</a>
											(<span class="var-type">$fieldsSelected</span>&nbsp;<span class="var-name">$fieldsSelected</span>, <span class="var-type">$mresult</span>&nbsp;<span class="var-name">$mresult</span>, <span class="var-type">$searchTerm</span>&nbsp;<span class="var-name">$searchTerm</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">search</span>
										<a href="#searchFlag" title="details" class="method-name">searchFlag</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">timestamp</span>
										<a href="#setDatastreamState" title="details" class="method-name">setDatastreamState</a>
											(<span class="var-type">$pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">$ds</span>&nbsp;<span class="var-name">$ds</span>, <span class="var-type">$state</span>&nbsp;<span class="var-name">$state</span>, <span class="var-type">$log</span>&nbsp;<span class="var-name">$log</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">html</span>
										<a href="#transform" title="details" class="method-name">transform</a>
											(<span class="var-type">$xsl_content</span>&nbsp;<span class="var-name">$xsl_content</span>, <span class="var-type">$xml_content</span>&nbsp;<span class="var-name">$xml_content</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">html</span>
										<a href="#transform2" title="details" class="method-name">transform2</a>
											(<span class="var-type">$xsl_content</span>&nbsp;<span class="var-name">$xsl_content</span>, <span class="var-type">$xml_doc</span>&nbsp;<span class="var-name">$xml_doc</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">timestamp</span>
										<a href="#updateDatastream" title="details" class="method-name">updateDatastream</a>
											(<span class="var-type">$path</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">$pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">$label</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">$type</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">$log</span>&nbsp;<span class="var-name">$log</span>)
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$nextFlag" id="$nextFlag"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$nextFlag</span>
						(line <span class="line-number">57</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$pwd" id="$pwd"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$pwd</span>
						(line <span class="line-number">55</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$searchToken" id="$searchToken"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$searchToken</span>
						(line <span class="line-number">59</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$UrlA" id="$UrlA"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$UrlA</span>
						(line <span class="line-number">49</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$UrlM" id="$UrlM"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$UrlM</span>
						(line <span class="line-number">51</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$user" id="$user"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$user</span>
						(line <span class="line-number">53</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Constructor.png" />
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">67</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class constructor - initializes apia-a and api-m uri based on the version of the fedora repository</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Agent</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodaddDatastream" id="addDatastream"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">addDatastream</span> (line <span class="line-number">502</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">adds a new datastream to the fedora object</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">timestamp</span>
		<span class="method-name">
			addDatastream
		</span>
					(<span class="var-type">$path</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">$pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">$label</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">$type</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">$group</span>&nbsp;<span class="var-name">$group</span>, <span class="var-type">$state</span>&nbsp;<span class="var-name">$state</span>, <span class="var-type">$log</span>&nbsp;<span class="var-name">$log</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$path</span>
				<span class="var-name">$path</span><span class="var-description">: content file to be ingested</span>			</li>
					<li>
				<span class="var-type">$pid</span>
				<span class="var-name">$pid</span><span class="var-description">: fedora object pid</span>			</li>
					<li>
				<span class="var-type">$label</span>
				<span class="var-name">$label</span><span class="var-description">: fedora object label</span>			</li>
					<li>
				<span class="var-type">$type</span>
				<span class="var-name">$type</span><span class="var-description">: content file mime-type</span>			</li>
					<li>
				<span class="var-type">$group</span>
				<span class="var-name">$group</span><span class="var-description">: control group</span>			</li>
					<li>
				<span class="var-type">$state</span>
				<span class="var-name">$state</span><span class="var-description">: state of the datastream</span>			</li>
					<li>
				<span class="var-type">$log</span>
				<span class="var-name">$log</span><span class="var-description">: the log message</span>			</li>
				</ul>
		
			
	</div>
<a name="methodaddDataStreams" id="addDataStreams"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">addDataStreams</span> (line <span class="line-number">631</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">updates the datastream of a fedora object</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addDataStreams
		</span>
					(<span class="var-type">$files</span>&nbsp;<span class="var-name">$files</span>, <span class="var-type">$state</span>&nbsp;<span class="var-name">$state</span>, <span class="var-type">$log</span>&nbsp;<span class="var-name">$log</span>, <span class="var-type">$label</span>&nbsp;<span class="var-name">$label</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$files</span>
				<span class="var-name">$files</span><span class="var-description">: array of content files to be ingested</span>			</li>
					<li>
				<span class="var-type">$state</span>
				<span class="var-name">$state</span><span class="var-description">: fedora datastream state</span>			</li>
					<li>
				<span class="var-type">$log</span>
				<span class="var-name">$log</span><span class="var-description">: the log message</span>			</li>
					<li>
				<span class="var-type">$label</span>
				<span class="var-name">$label</span><span class="var-description">: fedora object label</span>			</li>
				</ul>
		
			
	</div>
<a name="methodarrayToXML" id="arrayToXML"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">arrayToXML</span> (line <span class="line-number">476</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">converts PHP array into XML</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">xml</span>
		<span class="method-name">
			arrayToXML
		</span>
					(<span class="var-type">$result</span>&nbsp;<span class="var-name">$result</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$result</span>
				<span class="var-name">$result</span><span class="var-description">: php array</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcallModifyDatastreamByValue" id="callModifyDatastreamByValue"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">callModifyDatastreamByValue</span> (line <span class="line-number">585</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function modifies inline xml datastreams (ByValue)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			callModifyDatastreamByValue
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dsID</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$state</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dsContent</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'text/xml'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$versionable</span> = <span class="var-default">&quot;false&quot;</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pid</span><span class="var-description">: The persistant identifier of the object</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dsID</span><span class="var-description">: The name of the datastream</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$state</span><span class="var-description">: The datastream state</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$label</span><span class="var-description">: The datastream label</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dsContent</span><span class="var-description">: The datastream content</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$mimetype</span><span class="var-description">: The mimetype of the datastream</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$versionable</span><span class="var-description">: Whether to version control this datastream or not</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddescribeRepository" id="describeRepository"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">describeRepository</span> (line <span class="line-number">91</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">describes the repository</p>
	<ul class="tags">
				<li><span class="field">return:</span> settings like pid namespace, version etc.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">repository</span>
		<span class="method-name">
			describeRepository
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methoddescribeUser" id="describeUser"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">describeUser</span> (line <span class="line-number">311</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets the information about the fedora user</p>
	<ul class="tags">
				<li><span class="field">return:</span> info. as XML</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">user</span>
		<span class="method-name">
			describeUser
		</span>
					(<span class="var-type">id</span>&nbsp;<span class="var-name">$id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">id</span>
				<span class="var-name">$id</span><span class="var-description">: userid</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddomNodeList_to_string" id="domNodeList_to_string"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">domNodeList_to_string</span> (line <span class="line-number">428</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">converts DOMNODELIST into string</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			domNodeList_to_string
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$DomNodeList</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$DomNodeList</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetDatastream" id="getDatastream"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getDatastream</span> (line <span class="line-number">348</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets a particular fedora object datastream</p>
	<ul class="tags">
				<li><span class="field">return:</span> as an xml</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">datastream</span>
		<span class="method-name">
			getDatastream
		</span>
					(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">ds</span>&nbsp;<span class="var-name">$ds</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">pid</span>
				<span class="var-name">$pid</span><span class="var-description">: fedora PID</span>			</li>
					<li>
				<span class="var-type">ds</span>
				<span class="var-name">$ds</span><span class="var-description">: fedora datastream ID</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetDatastreamHistory" id="getDatastreamHistory"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getDatastreamHistory</span> (line <span class="line-number">368</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets history of fedora object</p>
	<ul class="tags">
				<li><span class="field">return:</span> of fedora object as an xml</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">history</span>
		<span class="method-name">
			getDatastreamHistory
		</span>
					(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">ds</span>&nbsp;<span class="var-name">$ds</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">pid</span>
				<span class="var-name">$pid</span><span class="var-description">: fedora PID</span>			</li>
					<li>
				<span class="var-type">ds</span>
				<span class="var-name">$ds</span><span class="var-description">: fedora datastream ID</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetDatastreams" id="getDatastreams"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getDatastreams</span> (line <span class="line-number">328</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets the fedora object datastreams</p>
	<ul class="tags">
				<li><span class="field">return:</span> as an array object</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">datastreams</span>
		<span class="method-name">
			getDatastreams
		</span>
					(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">pid</span>
				<span class="var-name">$pid</span><span class="var-description">: fedora PID</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetMarcXML" id="getMarcXML"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getMarcXML</span> (line <span class="line-number">388</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns a DOMELEMENT Object</p>
	<ul class="tags">
				<li><span class="field">return:</span> Object</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">DOMELEMENT</span>
		<span class="method-name">
			getMarcXML
		</span>
					(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">ds</span>&nbsp;<span class="var-name">$ds</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">pid</span>
				<span class="var-name">$pid</span><span class="var-description">: fedora PID</span>			</li>
					<li>
				<span class="var-type">ds</span>
				<span class="var-name">$ds</span><span class="var-description">: fedora datastream ID</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetNextPid" id="getNextPid"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getNextPid</span> (line <span class="line-number">249</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets the next pid for a particular namespace</p>
	<ul class="tags">
				<li><span class="field">return:</span> pid</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">next</span>
		<span class="method-name">
			getNextPid
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$namespace</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$namespace</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetObjectProfile" id="getObjectProfile"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getObjectProfile</span> (line <span class="line-number">276</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets the fedora object profile</p>
	<ul class="tags">
				<li><span class="field">return:</span> as XML</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object profile</span>
		<span class="method-name">
			getObjectProfile
		</span>
					(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">pid</span>
				<span class="var-name">$pid</span><span class="var-description">: fedora PID</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetSearchToken" id="getSearchToken"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getSearchToken</span> (line <span class="line-number">238</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets the search token (resumption token)</p>
	<ul class="tags">
				<li><span class="field">return:</span> token</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">search</span>
		<span class="method-name">
			getSearchToken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_file" id="get_file"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_file</span> (line <span class="line-number">690</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets content of the file</p>
	<ul class="tags">
				<li><span class="field">return:</span> content of the file</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">the</span>
		<span class="method-name">
			get_file
		</span>
					(<span class="var-type">$filename</span>&nbsp;<span class="var-name">$filename</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$filename</span>
				<span class="var-name">$filename</span><span class="var-description">: name of the file</span>			</li>
				</ul>
		
			
	</div>
<a name="methodInsertXML" id="InsertXML"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">InsertXML</span> (line <span class="line-number">411</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">inserts xml node into source xml</p>
	<ul class="tags">
				<li><span class="field">return:</span> DOCUMENT</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">DOM</span>
		<span class="method-name">
			InsertXML
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$source</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ingestSource</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$source</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$ingestSource</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlistDatastreams" id="listDatastreams"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">listDatastreams</span> (line <span class="line-number">258</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			listDatastreams
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$pid</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$pid</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlistMethods" id="listMethods"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">listMethods</span> (line <span class="line-number">294</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets the fedora object methods</p>
	<ul class="tags">
				<li><span class="field">return:</span> as XML</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object methods</span>
		<span class="method-name">
			listMethods
		</span>
					(<span class="var-type">pid</span>&nbsp;<span class="var-name">$pid</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">pid</span>
				<span class="var-name">$pid</span><span class="var-description">: fedora PID</span>			</li>
				</ul>
		
			
	</div>
<a name="methodnextSearch" id="nextSearch"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">nextSearch</span> (line <span class="line-number">171</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">next search for the repository</p>
	<ul class="tags">
				<li><span class="field">return:</span> result as XML</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">search</span>
		<span class="method-name">
			nextSearch
		</span>
					(<span class="var-type">$token</span>&nbsp;<span class="var-name">$token</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$token</span>
				<span class="var-name">$token</span><span class="var-description">: The next search token</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsearch" id="search"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">search</span> (line <span class="line-number">113</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">searches the repository</p>
	<ul class="tags">
				<li><span class="field">return:</span> result as XML</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">search</span>
		<span class="method-name">
			search
		</span>
					(<span class="var-type">$fieldsSelected</span>&nbsp;<span class="var-name">$fieldsSelected</span>, <span class="var-type">$mresult</span>&nbsp;<span class="var-name">$mresult</span>, <span class="var-type">$searchTerm</span>&nbsp;<span class="var-name">$searchTerm</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$fieldsSelected</span>
				<span class="var-name">$fieldsSelected</span><span class="var-description">: The metadata fields to be returned</span>			</li>
					<li>
				<span class="var-type">$mresult</span>
				<span class="var-name">$mresult</span><span class="var-description">: The max nnumber of results to be returned per page</span>			</li>
					<li>
				<span class="var-type">$searchTerm</span>
				<span class="var-name">$searchTerm</span><span class="var-description">: the term searching for</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsearchFlag" id="searchFlag"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">searchFlag</span> (line <span class="line-number">227</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gets the search fleg</p>
	<ul class="tags">
				<li><span class="field">return:</span> flag, boolean</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">search</span>
		<span class="method-name">
			searchFlag
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetDatastreamState" id="setDatastreamState"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">setDatastreamState</span> (line <span class="line-number">456</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">sets the datastream state to active/inactive</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">timestamp</span>
		<span class="method-name">
			setDatastreamState
		</span>
					(<span class="var-type">$pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">$ds</span>&nbsp;<span class="var-name">$ds</span>, <span class="var-type">$state</span>&nbsp;<span class="var-name">$state</span>, <span class="var-type">$log</span>&nbsp;<span class="var-name">$log</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$pid</span>
				<span class="var-name">$pid</span><span class="var-description">: fedora object pid</span>			</li>
					<li>
				<span class="var-type">$ds</span>
				<span class="var-name">$ds</span><span class="var-description">: fedora datatstream ID</span>			</li>
					<li>
				<span class="var-type">$state</span>
				<span class="var-name">$state</span><span class="var-description">: state of the datastream</span>			</li>
					<li>
				<span class="var-type">$log</span>
				<span class="var-name">$log</span><span class="var-description">: the log message</span>			</li>
				</ul>
		
			
	</div>
<a name="methodtransform" id="transform"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">transform</span> (line <span class="line-number">709</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">transforms xml into html using xsl stylesheet</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">html</span>
		<span class="method-name">
			transform
		</span>
					(<span class="var-type">$xsl_content</span>&nbsp;<span class="var-name">$xsl_content</span>, <span class="var-type">$xml_content</span>&nbsp;<span class="var-name">$xml_content</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$xsl_content</span>
				<span class="var-name">$xsl_content</span><span class="var-description">: content of xsl stylesheet</span>			</li>
					<li>
				<span class="var-type">$xml_content</span>
				<span class="var-name">$xml_content</span><span class="var-description">: content of source xml</span>			</li>
				</ul>
		
			
	</div>
<a name="methodtransform2" id="transform2"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">transform2</span> (line <span class="line-number">747</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">transforms xml DOM Object into html using xsl stylesheet</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">html</span>
		<span class="method-name">
			transform2
		</span>
					(<span class="var-type">$xsl_content</span>&nbsp;<span class="var-name">$xsl_content</span>, <span class="var-type">$xml_doc</span>&nbsp;<span class="var-name">$xml_doc</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$xsl_content</span>
				<span class="var-name">$xsl_content</span><span class="var-description">: content of xsl stylesheet</span>			</li>
					<li>
				<span class="var-type">$xml_doc</span>
				<span class="var-name">$xml_doc</span><span class="var-description">: XMl DOM DOcument object</span>			</li>
				</ul>
		
			
	</div>
<a name="methodupdateDatastream" id="updateDatastream"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">updateDatastream</span> (line <span class="line-number">547</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">updates the datastream of a fedora object</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">timestamp</span>
		<span class="method-name">
			updateDatastream
		</span>
					(<span class="var-type">$path</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">$pid</span>&nbsp;<span class="var-name">$pid</span>, <span class="var-type">$label</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">$type</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">$log</span>&nbsp;<span class="var-name">$log</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$path</span>
				<span class="var-name">$path</span><span class="var-description">: content file to be ingested</span>			</li>
					<li>
				<span class="var-type">$pid</span>
				<span class="var-name">$pid</span><span class="var-description">: fedora object pid</span>			</li>
					<li>
				<span class="var-type">$label</span>
				<span class="var-name">$label</span><span class="var-description">: fedora object label</span>			</li>
					<li>
				<span class="var-type">$type</span>
				<span class="var-name">$type</span><span class="var-description">: content file mime-type</span>			</li>
					<li>
				<span class="var-type">$log</span>
				<span class="var-name">$log</span><span class="var-description">: the log message</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Tue, 07 Aug 2007 07:59:52 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>